home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / time / sclock / sclock.doc < prev    next >
Encoding:
Text File  |  1994-04-02  |  16.7 KB  |  616 lines
  1.       *****************************************************
  2.                         SClock V1.72 (DOC)
  3.  
  4.                                 by
  5.  
  6.            Rune Johnsrud / (c) 1994 Pork Soda Softworks
  7.       *****************************************************
  8.  
  9.  
  10. ----------
  11. IMPORTANT:
  12. ----------
  13.  
  14. The author of this program is not in any way responsible for any
  15. damage caused by this software WHAT SO EVER!!!
  16.  
  17. This version of SClock (and it's source code) is FREEWARE, so you
  18. can give it to anyone you want.  It should be distributed as
  19. FREEWARE, and anyone can include it in their PD library (or
  20. something similar), as long as they charge only a minor fee for
  21. copying, and as long as all the files in the archive accompany it
  22. (and the archive contents remains unchanged!!!).
  23.  
  24. Fred Fish is also allowed to include this program in his excellent
  25. PD library.
  26.  
  27. Computer magazines and other computer publications are NOT allowed
  28. to include it with their product without my written permission!!!!
  29.  
  30.  
  31.  
  32. -------------------------------
  33. What do you need to use SClock:
  34. -------------------------------
  35.  
  36. You will need:
  37.  
  38.   * One (or more) Amiga(s) (!)
  39.   * A MC68020 processor (or higher),
  40.     (SClock has been extensively tested on A1200,A4000 030 and
  41.      A4000 040.)
  42.   * At least Kickstart V3.0 (V39) (or higher).
  43.  
  44.  
  45. Things you DON'T really need:
  46.  
  47.   * Some nice fonts
  48.   * Some nice IFF/GIF/BMP/JPEG/PCX pictures...
  49.  
  50.  
  51. ----------------
  52. Getting started:
  53. ----------------
  54.  
  55. To install this version of SClock, just copy the main executable
  56. (SClock), and one of the supplied icons (SClockAnalog.info,
  57. SClockDigital.info or SClock.info) to the desired directory and
  58. rename the chosen icon to Sclock.info if a MUI icon is used.
  59.  
  60. (SClockAnalog.info has of course a default analog setup and
  61. SClockDigital.info a default digital setup.)
  62.  
  63. This program is "A Workbench ONLY" program, so to be able to use
  64. it, it's important that the original icon (or a "similar" copy)
  65. accompanies the executable.
  66.  
  67.  
  68.  
  69. -------------
  70. Using SClock:
  71. -------------
  72.  
  73. To start SClock just double click on it's icon, and if everything
  74. starts ok, a "window" that contains the current system time will
  75. appear. The appearence of the display window depends upon which of
  76. the two diplay types has been selected, "ANALOG" or "DIGITAL".
  77.  
  78. If an error message appears or it just won't start, read on.
  79.  
  80. To quit SClock, activate the clock window, and select the
  81. "Project/Quit" menu item, or press "Right Amiga Q".
  82.  
  83.  
  84.  
  85. -------------------
  86. Configuring SClock:
  87. -------------------
  88.  
  89. SClock allows you to make a lot of changes to it's "original"
  90. appearance.  Just read on and you will find out more about the
  91. different configuration possibilities.
  92.  
  93. All the different configuration possibilities are accessible
  94. trough the "SClock.info" icon file.  Use the Workbench
  95. "Icon/Information" program to edit the different tool types.  Some
  96. of the different configuration options are also accessible through
  97. the menu that accompanies the clock window.  (Click on the
  98. ClockWindow, press the right mouse button and a menu will appear).
  99.  
  100. All the different tool type values have internal default settings,
  101. so if you REM away all/or some tool types the internal defaults
  102. will be used.
  103.  
  104.  
  105.  
  106. The different tool types are:
  107. -----------------------------
  108.  
  109.  
  110.     * DONOTWAIT
  111.  
  112.         This will allow you to start SClock from the  WBStartup drawer.
  113.  
  114.  
  115.     * PUBSCREEN=<pubscreenname>
  116.  
  117.         This allows you to start (put) the clock on any public
  118.         screen that is open.  The name must be spelled right
  119.         (case is IMPORTANT).  If no name is specified,
  120.         the Workbench screen (or default public screen) will
  121.         be used.
  122.  
  123.         If it fails to open on the specified public screen,
  124.         it will display this error message:
  125.         "Couldn't lock specified public screen".
  126.         Check the "pubscreenname" you have specified,
  127.         and try again.
  128.  
  129.  
  130.     * CLOCKTYPE=<ANALOG|DIGITAL>
  131.  
  132.         This option specifies what type of display you want.
  133.         The different options are: "ANALOG" or "DIGITAL".
  134.  
  135.         Depending on what kind of "CLOCKTYPE" you have specified,
  136.         other different options might not work, and others may start
  137.         working. Look at the SClock_ToolTypes.DOC file too se which
  138.         tooltypes that are "active" when selecting the different
  139.         "CLOCKTYPE"'s.
  140.  
  141.  
  142.     * GLOBALFLAGS=<SHOWDATE|SHOWSEC|EDGEBEVEL|BACKDROPWIN|LOCKPOS>
  143.  
  144.         This option allows you to define a bulk of general flags
  145.         (or settings).
  146.  
  147.         SHOWDATE specifies if the current date should be
  148.         displayed.
  149.  
  150.         SHOWSEC specifies if the seconds of the current time
  151.         should be dsiplayed.
  152.  
  153.         EDGEBEVEL specifies if a bevel box should be drawn
  154.         around the time/date display.  (Colors/Pens used are
  155.         specified using the "SHINEPEN" and "SHADOWPEN"
  156.         tooltypes).
  157.         If this flag is not disabled, no bevel edge will be drawn.
  158.         This is especially useful together with the "BACKDROPWIN"
  159.         tooltype.
  160.  
  161.         BACKDROPWIN specifies if the clock display is a
  162.         BACKDROPWINDOW or a normal window.
  163.         If you always want your clock display to stay at the
  164.         bottom, activate this tooltype.
  165.  
  166.         LOCKPOS specifies whether you will be able to move the clock
  167.         display around or not.
  168.  
  169.  
  170.         To enable/disable the different options, do the following:
  171.  
  172.  
  173.  
  174.                          DISABLED           DISABLED
  175.                             ||                 ||
  176.                             \/                 \/
  177.         GLOBALFLAGS=SHOWDATE|;SHOWSEC|EDGEBEVEL|;BACKDROPWIN|LOCKPOS
  178.                     /\                /\
  179.                     ||                ||
  180.                  ENABLED           ENABLED
  181.  
  182.  
  183.     * LEFTPOS=<xpos>
  184.  
  185.         This number specifies the leftmost position of the 
  186.         clock when it is started. Default is 0.
  187.         This option is also adjustable from SClock.
  188.  
  189.  
  190.     * TOPPOS=<ypos>
  191.  
  192.         This number specifies the top position of the clock
  193.         window when it is started. Default is 0.
  194.         This option is also adjustable from SClock.
  195.  
  196.  
  197.     * WIDTH=<xsize>
  198.  
  199.         The width of the "ANALOG" clock display window in pixels.
  200.         Default is 100, minimum is 50.
  201.  
  202.  
  203.     * HEIGHT=<ysize>
  204.  
  205.         The height of the "ANALOG" clock display window in pixels.
  206.         Default is 100, minimum is 50.
  207.  
  208.  
  209.     * FONTNAME=<fontname.font>
  210.  
  211.         This option specifies which font the time/date text
  212.         will be displayed with when the clock is started.
  213.         Default is "topaz.font".
  214.  
  215.         If SClock fails to open the font, it will display
  216.         the following error message:
  217.         "Couldn't open specified font".
  218.         Check the specified font name, and try again.
  219.  
  220.         This option is also "adjustable" from SClock.
  221.  
  222.  
  223.     * FONTSIZE=<ysize>
  224.  
  225.         This option specifies the YSize of the font used.
  226.         Default is 8.
  227.  
  228.         This option is also "adjustable" from SClock.
  229.  
  230.  
  231.     * TEXTPEN=<pen-number>
  232.  
  233.         Specifies the pen number (colour number) that the time/date
  234.         text will be displayed with (range 0-255).
  235.         Default is 1.
  236.  
  237.  
  238.     * BGPEN=<pen-number>
  239.  
  240.         Specifies the pen number (colour number) that the background
  241.         will be displayed with (range 0-255).
  242.         Default is 3.
  243.  
  244.  
  245.         If this tooltype is not present, no bevel edge will be drawn.
  246.         This is especially useful together with the "BACKDROPWIN"
  247.         tooltype.
  248.  
  249.  
  250.     * SHINEPEN=<pen-number>
  251.  
  252.         Specifies the pen number (colour number) that the left/top
  253.         border will be displayed with (range 0-255).
  254.         Default is 2.
  255.  
  256.  
  257.     * SHADOWPEN=<pen-number>
  258.  
  259.         Specifies the pen number (colour number) that the right/bottom
  260.         border will be displayed with (range 0-255).
  261.         Default is 1.
  262.  
  263.  
  264.  
  265. DIGITAL Tooltypes:
  266. ------------------
  267.  
  268.  
  269.     * DIGITALFLAGS=<flags>
  270.  
  271.         No flags are available in the present version 
  272.  
  273.  
  274.     * DATEFORMAT=<format-num>
  275.  
  276.         This option specifies the format of the date display string.
  277.         Defalt is 0.
  278.  
  279.         The different formats are:
  280.  
  281.         Format 0: "dd.mmm.yyyy"     - Ex: 31.May.1993
  282.         Format 1: "dd.mmm.yy"       - Ex: 31.May.93
  283.         Format 2: "dd.mm.yyyy"      - Ex: 31.05.1993
  284.         Format 3: "dd.mm.yy"        - Ex: 31.05.93
  285.  
  286.  
  287.     * DATESEPARATOR=<separator-char>
  288.  
  289.         This option specifies the character that will be used to
  290.         separate the Day/Month/Year strings. Default is ".".
  291.  
  292.         Specifying a "-" char will produce a display like this:
  293.         "dd-mmm-yyyy" 
  294.  
  295.  
  296.     * DATESPACING=<num_of_chars>
  297.  
  298.         This option specifies the amount of "blank" space that will
  299.         appear between the time and date display. Default is 2.
  300.  
  301.  
  302.     * TIMESEPARATOR=<separator-char>
  303.  
  304.         This option specifies the character that will be used to
  305.         separate the Hour/Minute/Second numbers. Default is ":".
  306.  
  307.         Specifying a "/" char will produce a display like this:
  308.         "hh/mm/ss" 
  309.  
  310.  
  311.  
  312.  
  313. ANALOG ToolTypes:
  314. -----------------
  315.  
  316.  
  317.     * ANALOGFLAGS=<PLACECLOCK|SHOWDIAL|AUTOSIZE>
  318.  
  319.         This option allows you to define a bulk of Analog flags
  320.         (or settings).
  321.  
  322.         PLACECLOCK specifies if the clockdial can be indipendantly
  323.         moved around inside the render box.
  324.         To control the exact placement, use the "CLOCKLEFT",
  325.         "CLOCKTOP", "CLOCKWIDTH" and "CLOCKHEIGHT" tooltypes.
  326.         Experiment with the settings and see what happens!!!!
  327.  
  328.         SHOWDIAL specifies if the clock dial should be drawn or
  329.         not.
  330.  
  331.         AUTOSIZE specifies if the clock display render box should
  332.         be automatically sized to fit any backdrop picture
  333.         selected (overides the "WIDTH" and "HEIGHT" settings).
  334.  
  335.         To enable/disable the different options, do the following:
  336.  
  337.  
  338.  
  339.                             DISABLED
  340.                               || 
  341.                               \/ 
  342.         ANALOGFLAGS=PLACECLOCK|;SHOWDIAL|AUTOSIZE>
  343.                     /\                   /\
  344.                     ||                   ||
  345.                  ENABLED              ENABLED
  346.  
  347.  
  348.     * BACKDROP=<picture_name>
  349.  
  350.         Specifies path/filename for any picture that you want as a backdrop
  351.         on your "ANALOG" clock display window.
  352.  
  353.         The parsing of the pictures is done by datatypes, and only picture
  354.         types that you have datatypes for will be used and/or displayed.
  355.  
  356.  
  357.     * EDGESPACING=<pixels>
  358.  
  359.         The number of pixels used as spacing between the display window
  360.         edge and the "edge" of the clock dial.
  361.  
  362.  
  363.     * MINXSCALE=<scale_factor>
  364.  
  365.         The number specified is used as to define the X size of the large
  366.         5 min. indicator dots.
  367.  
  368.  
  369.     * MINYSCALE=<scale_factor>
  370.  
  371.         The number specified is used as to define the Y size of the large
  372.         5 min. indicator dots.
  373.  
  374.  
  375.     * CLOCKLEFT=<x_pos>
  376.  
  377.         This number specifies the left position of the clock dial inside
  378.         the display window when it is started. Default is 0.
  379.  
  380.  
  381.     * CLOCKTOP=<y_pos>
  382.  
  383.         This number specifies the top position of the clock dial inside
  384.         the display window when it is started. Default is 0.
  385.         
  386.  
  387.     * CLOCKWIDTH=<x_size>
  388.  
  389.         The width of the clock dial in pixels.
  390.         Default is 50.
  391.  
  392.  
  393.     * CLOCKHEIGHT<y_size>
  394.  
  395.         The height of the clock dial in pixels.
  396.         Default is 50.
  397.  
  398.  
  399.     * MINSMALLPEN=<pen-number>
  400.  
  401.         Specifies the pen number that the small minute indicator
  402.         dots will be displayed with. Default is 1.
  403.  
  404.  
  405.     * MINLARGEPEN=<pen-number>
  406.  
  407.         Specifies the pen number that the large 5 minute indicator
  408.         dots will be displayed with. Default is 3.
  409.  
  410.  
  411.     * SECPEN=<pen-number>
  412.  
  413.         Specifies the pen number that the second indicator will be
  414.         displayed with. Default is 1.
  415.  
  416.  
  417.     * MINPEN=<pen-number>
  418.  
  419.         Specifies the pen number that the minute indicator will be
  420.         displayed with. Default is 0.
  421.  
  422.  
  423.     * HOURPEN=<pen-number>
  424.  
  425.         Specifies the pen number that the hour indicator will be
  426.         displayed with. Default is 0.
  427.  
  428.  
  429.     * DIALPEN=<pen-number>
  430.  
  431.         Specifies the pen number that the clock dial will be
  432.         displayed with.
  433.  
  434.  
  435.     * DIALOUTILINEPEN=<pen-number>
  436.  
  437.         Specifies the pen number that the dial outline will be
  438.         displayed with.
  439.  
  440.  
  441.  
  442.  
  443.  
  444. Experiment with the different tool types to satisfy your personal taste.
  445.  
  446.  
  447.  
  448. -------------
  449. SClock menus:
  450. -------------
  451.  
  452. If you activate the clock window and press the right mouse button
  453. (menu button), the SClock menus will appear.
  454.  
  455. They are:
  456. ---------
  457.  
  458.     * Project/About [Right Amiga ?]
  459.  
  460.         Upon selecting this menu item, a window will appear
  461.         that contains info about SClock.
  462.  
  463.  
  464.     * Project/Quit [Right Amiga Q]
  465.  
  466.         Selecting this quits SClock, (the clock window will close
  467.         and all used resources will be freed!! (I hope)).
  468.  
  469.  
  470.     * Settings/Font [Right Amiga F]
  471.  
  472.         Selecting this menu item enables you to select a new font
  473.         that will be used to display the time/date text.
  474.         The Asl Font requester is used to display the different
  475.         fonts available.
  476.         If you select "OK", the clock window will close, and 
  477.         then re-open, with the new font.
  478.         If you select "Cancel", the old font will be used.
  479.  
  480.         This menu item is only available when the "DIGITAL"
  481.         clock display is used.
  482.  
  483.     * Settings/Backdrop [Right Amiga B]
  484.  
  485.         Selecting this menu item enables you to select a new
  486.         backdrop that will be used as a background picture in 
  487.         the clock display.
  488.         The Asl File requester is used to display the different
  489.         backdrops available (only the picture file types that you
  490.         have datatypes for will be displayed!!!).
  491.         If you select "OK", the clock window will close, and 
  492.         then re-open, with the new backdrop.
  493.         If you select "Cancel", the old backdrop will be used.
  494.  
  495.     * Settings/Save Settings [Right Amiga S]
  496.  
  497.         Selecting this menu item will snapshot the current window
  498.         position, selected font and font size and or backdrop
  499.         picture, and save these settings in the "SClock.info" icon file
  500.         (Edit it and see!!)..
  501.  
  502.  
  503. -------
  504. Errors:
  505. -------
  506.  
  507. SClock will put up different requesters when it encounters
  508. problems, and I hope that the displayed messages will clarify what
  509. went wrong.
  510.  
  511. If you have enabled the "SHOWDATE" option and you select a LARGE
  512. font (75-128 pts), SClock will display a message that says that
  513. the window is to large, and that it will be truncated.  You will
  514. now be able to only see the clock as long as the font makes the
  515. window to large.  But at the moment you select a font that makes
  516. it possible for the window to fit into the current screen, the
  517. date information will be displayed again.
  518.  
  519.  
  520. -----------
  521. Misc stuff:
  522. -----------
  523.  
  524. The number of configuration combinations you can achieve, makes it
  525. possible to make a lot of different "looks".  And don't hesitate
  526. to experiment with the different tool types to make it appear
  527. just as YOU want it!!
  528.  
  529. Another thing that I just want to mention is that SClock uses less
  530. CPU time than any other clock I have seen so far.  (Atleast the
  531. ones that are system friendly...)
  532.  
  533.  
  534. -------------------
  535. SClock Source code:
  536. -------------------
  537.  
  538. Since it only took a couple of days to write this program, I though
  539. that I might release the source code as well.
  540.  
  541. It's not well documented (if documented at all), and not really
  542. that well written.
  543.  
  544. To compile it you will need SAS/C 6.0 (preferably SAS/C 6.3).
  545.  
  546.  
  547.  
  548. -------------------
  549. Last but not least:
  550. -------------------
  551.  
  552. This version of SClock was written on an A4000-030 (Standard eqpt),
  553. using the following tools:
  554.  
  555.     * SAS/C 6.5         - The best (and only).
  556.     * CygnusEd V3.5     - Yeah... I need speed!!!
  557.     * MakeIndex         - (System function/struct lookup system for CEd).
  558.     * DOpus V4.10       - The ultimate DIR util...
  559.  
  560.  
  561.  
  562. ------------------------
  563. Credits 'n' other stuff:
  564. ------------------------
  565.  
  566.  
  567. Here are the usual credits............
  568.  
  569.  
  570. Thanks to:
  571. ----------
  572.  
  573.  
  574.     * Lars Hamre      - The guy that wanted this program in the first place
  575.     * Anders Hamre    - For seeing and liking, bass, and good times
  576.     * Kim Jensen      - For just being Kim.
  577.     * Henning H.      - The PC freak of this century (maker of SBStudio).
  578.     * Stig J.         - For having a drivers licence, playing the bass-guitar,
  579.                         and generally being a nice fellow
  580.     * Arild Skullerud - For painting MUI style icons.
  581.  
  582.       Tor Einar Jarnbjo, Morten W. Lund, Øystein Hungerholt (sound friend),
  583.       Amiga Forum (the only serious alternative),
  584.       Commodore (for not leaving us, yet!), etc........
  585.  
  586.  
  587.     * With inspiration from:
  588.  
  589.         Genesis, Yes, ELP, Fish, Marillion, Primus, Rush, Brand-X,
  590.         King Crimson, Sylvian/Fripp, Percy Jones, Allan Holdsworth,
  591.         Mick Karn....
  592.         
  593.         Greetings to all fellow Prog Rockers out there, we are a
  594.         dying breed.
  595.  
  596.  
  597.  
  598.  
  599.  
  600. I hope you find this program useful....
  601.  
  602.  
  603. If you want to contact me, write to:
  604.  
  605.  
  606. Rune Johnsrud
  607. Skogveien 16
  608. 2010 STRØMMEN
  609. NORWAY
  610.  
  611. (Sorry, no BBS numbers, EMAIL, etc.....)
  612.  
  613.  
  614.  
  615. /* End Of File */
  616.